IModule.ReadSdoString method

Reads a string through Service Data Object (SDO).

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB
IKsCommand<string> ReadSdoString(
       ushort index,
       byte subIndex,
       bool completeAccess,
       Encoding encoding,
       int length = 64
)
Function ReadSdoString(
       index As UShort,
       subIndex As Byte,
       completeAccess As Boolean,
       encoding As Encoding,
       length = 64 As Integer
) As IKsCommand(Of String)

Parameters

index

Type: ushort

The index of the object to read in the object dictionary.

 

subIndex

Type: byte

The subindex of the object to read in the object dictionary.

 

completeAccess

Type: bool

true: Reads all subindexes. false: Reads a single subindex.

 

encoding

Type: Encoding

The encoding used to convert the bytes into a string.

 

length

Type: Int32

Default value: 64

The data length of the object to read in the object dictionary.

Return value

Type: IKsCommand<string>

Returns the states of a method and a string.

See also

IModule Interface

IntervalZero.KINGSTAR.Base.Class Namespace